home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / fish / 701-725 / 718 / bootpic / bootpic.doc < prev    next >
Text File  |  1995-03-18  |  15KB  |  332 lines

  1. *******************************************************************************
  2. *                                                                             *
  3. *                                 BootPicV2.1                                 *
  4. *                                                                             *
  5. *                         © 1991,92 by Andreas Ackermann                      *
  6. *                                                                             *
  7. *******************************************************************************
  8.  
  9. CONTENTS:______________________________________________________________________
  10.  
  11.  
  12.        1. About shareware
  13.        2. Introduction
  14.        3. Installation of a picture
  15.        4. About the Parser
  16.        5. Kompatibility
  17.        6. What happens after resetting the machine ?
  18.        7. Possible sources of errors
  19.        8. History
  20.        9. About the programming
  21.  
  22. _______________________________________________________________________________
  23.  
  24. ­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­
  25. SHAREWARE-CONDITIONS:
  26.  
  27.     BootPic is SHAREWARE. You are allowed to copy BootPic as long as the
  28.     following conditions are kept :
  29.  
  30.     o  BootPic mustn't be changed
  31.     o  This DOC-file must be included
  32.     o  It mustn't be charged any fee (besides fees for copying or disks etc.)
  33.  
  34.     If you like BootPic and if you use it regularly or if you include parts of
  35.     the source in your own programms (e.g. the fading-routines) please send me
  36.     a small donation of 5$ or 5DM.
  37.     For another $5 you'll get the latest Version and the source ( scarcely
  38.     documented).
  39.  
  40.     If you want to use BootPic as part of a commercial programme, you need my
  41.     written permission.
  42.  
  43.     My Address:            Andreas Ackermann
  44.                            Lorenz-Summa-Str.10
  45.                            W-8679 Oberkotzau
  46.                            GERMANY
  47.                            Tel.:09286/6399
  48.  
  49.     Starting with V2.0c it's prohibited to spread BootPic on any disk which
  50.     costs more than $5 ( or a corresponding amount of another currency ).
  51.     If you find BootPic on such an expensive disk please tell me !!!
  52.  
  53. ­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­
  54.  
  55.                                INTRODUCTION
  56.  
  57. Do you belong to the group of people who think the «Workbench-hand» that
  58. appears after every reset to be boring ?
  59. Then BootPic is the right thing for you. It allows you to load (nearly) any
  60. IFF-ILBM-picture instead of the «hand». (Overscan, HAM, Halfbright, etc.) It
  61. just has to be in compressed form. (e.g. DPaint saves its pictures in com-
  62. pressed form ).
  63. The installed programme uses 1K more memory than the length of the picture-
  64. file. [ starting with V1.2 I use CHIP-Mem to avoid complications ! ]
  65. Starting with V2.0 it's also possible to load a MED-Module that is played while
  66. the picture is shown. MED is a Music-programm comparable to SoundTracker. The
  67. V3.00 of this programm is to be found on Fish 476. Please note: When you save
  68. your Music make sure that you selected 'MED-Module' as output format. That's
  69. the only one that can be handled by BootPic. (MED also loads SoundTracker-
  70. Modules and then you may save them in the MED-Module format !!!)
  71. ( A Demo-Module is provided in this drawer. )
  72. As these modules usually are quite large, you may also load modules crunched
  73. with the PowerPackerV2.3b ( Fish 253 ). Note: Crunched Modules may need up to
  74. 10s to decrunch at each reset !
  75.  
  76.                                INSTALLATION
  77.  
  78. BootPic can be started either from Workbench or CLI.
  79. If started from WB an intuition-style window with five gadgets will open :
  80.  
  81.  Load Pic&Music : If you click on this gadget a window with a stringgadget will
  82.                 open and asks you to enter a filename. If you press RETURN,
  83.                 BootPic will try to load this Picture, clicking on Cancel
  84.                 will stop any action. If you've got the ARP-Library installed,
  85.                 you'll get the ARP-Filerequester.
  86.                 If you selected BootPic together with another icon (see at
  87.                 example) you'll find its name already written in the string-
  88.                 gadget when opening the filerequester.
  89.                 After that you're asked whether you want to install a MED-
  90.                 Module or not.
  91.                 If you wanted to, the Requester (or the Stringgadget) will
  92.                 prompt you for another filename.
  93.                 After inputting a path, BootPic will try to load the picture.
  94.                 If an error occurs, nothing will be installed; if there's an
  95.                 error while loading the MED-Module only the picture will be
  96.                 installed.
  97.                 It's impossible to install a MED-Module without installing a
  98.                 picture.
  99.                 When loading a crunched module BootPic is unable to check
  100.                 whether it is a module or not !
  101.  Remove Picture :
  102.                 Does nothing but that.
  103.  Check only df0:
  104.                 If this gadget is active when loading a picture, only the
  105.                 internal drive will be checked for bootable disks ( as usual)
  106.                 If it's deactivated you may boot from ANY drive you like.
  107.                 (including Kick 1.2/1.3 ! )
  108.                 The drive containing a bootable Disk is then called df0: and
  109.                 the internal drive may be accessed by the name of the other
  110.                 drive ( e.g. df2: )
  111.                 IMPORTANT:
  112.                 The state of this gadget is significant BEFORE loading an pic-
  113.                 ture. Toggling it after loading doesn't have any effect on the
  114.                 picture.
  115.  Color-Cycling: If it's active, it enables Color-Cycling if the corresponding
  116.                 information is saved with the picture ( CRNG-chunk )
  117.  Info :         Displays an info-message.
  118.  
  119. The error-messages are exactly the same as described below.
  120.  
  121. The color used to fade to after displaying the picture is taken from the
  122. background color of the workbench screen at the moment it is being installed.
  123.  
  124. EXAMPLE:
  125. ­­­­­­­­   To install the picture that is included on this Disk, do the
  126.            following steps:
  127.            Open the BootPic-drawer. Click on the demo.pic icon. Then double-
  128.            click on the BootPic icon while holding the SHIFT-key.
  129.            Click on the Load Picture -gadget and press RETURN.
  130.            Select 'Yes' in the requester that pops up afterwards.
  131.            Enter 'DemoSong.mod' and press RETURN
  132.            After resetting and removing any disks in df0: you can watch the
  133.            picture and enjoy the sound.
  134.  
  135.  
  136.  
  137. When started from CLI, BootPic is controlled by commandline parameters as
  138. usual. If no parameters are specified, a window as described above will open.
  139. The syntax is as follows :
  140.  
  141.           BootPic -e | -l{IFF-File} [-m{MED-Module}][-s][-r][-c rgb][-k][-y]
  142.                                     [-d time]
  143. -l{IFF-File}  Removes, if present, an old picture and then tries to install
  144.               a new one instead.
  145.  
  146.               Message if it had success:
  147.               «Picture successfully installed. Have Fun !»
  148.  
  149.               Possible faults:
  150.               «Couldn't open Picture-File»
  151.               «This is not an ILBM-Picturefile»
  152.               «Picture is not compressed»
  153.               «Warning:Couldn't find CAMG-Chunk»
  154.               CAMG-Chunk not found : The viewmodes are saved in this chunk
  155.               [e.g. Hires or Interlace etc.]. Until Kickstart 1.3 the picture
  156.               will be shown correctly despite of CAMG's missing.
  157.               [RESTRICTION: instead of Halfbright, HAM will be selected.]
  158.               «BODY-Chunk not found»
  159.               ILBM-File didn't contain image-data (should never happen).
  160.               «Memlist corrupt. Something went totally wrong»
  161.               Meaning see at -e
  162.               «Not enough Memory»
  163.               «Couldn't open Module / Not a MED-Module»
  164.               Error while loading the MED-Module:[either one of these]
  165.               - lack of memory
  166.               - file wasn't a module
  167.               - file not found
  168.               Nevertheless, the picture itself will be installed.
  169.  
  170. -e            Removes, if present, an old picture.
  171.  
  172.               Message if successful:
  173.               «Removed BootPic from List»
  174.  
  175.               Possible faults:
  176.               «BootPic not installed. Couldn't remove it»
  177.               «Memlist corrupt. Something went totally wrong»
  178.               BootPic discovered its memory, but it couldn't find its entry in
  179.               the resident table (should never happen).
  180.  
  181.               The following parameters work only together with -l :
  182.  
  183. -m{MED-Module}
  184.               loads additionally a MED-Module. If it can't be loaded, just the
  185.               picture will be installed.
  186. -s            loads the file specified by -l only if BootPic is not yet
  187.               installed. In this way it is possible to use BootPic in the
  188.               Startup-Sequence.
  189.  
  190.               If BootPic was already installed it prints out :
  191.               «BootPic already installed. Changed nothing.»
  192.  
  193. -r            BootPic resets the machine after loading the picture.
  194.  
  195. -c            here you can specify the color which should be faded in after
  196.               showing the picture. Normally this is the background color of
  197.               your Workbench-Screen. The values of r,g and b must be specified
  198.               hexadecimal, so values from 0-9 and a-f are valid. [0 means that
  199.               this component isn't there at all and f means that it is there at
  200.               maximum idensity. (e.g. -c000 for black, -ce50 for orange).
  201.               Invalid values are accepted but the result will be other than
  202.               expected.
  203.               Default: 05a [Amiga-blue]
  204. -k            enables checking of all drives [see above]
  205.               [ usage is invers: Specifying -k has got the same effect as
  206.                 deactivating 'Check only df0:' ]
  207. -y            enables color-cycling [see above]
  208. -d time       displays the picture only a certain time and then continues
  209.               bootup. ( Useful with Harddisks )
  210.               NOTE: time must be of one figure ( 0-9 )
  211.  
  212.                                 ABOUT the PARSER
  213.  
  214.  All parameters may be specified either as small or capital letters. Every
  215.  parameter MUST start with «-», the order is at pleasure. Between the single
  216.  parmeters any number of spaces may be typed .
  217.  
  218.  Valid calls would be :
  219.  
  220.   bootpic  -l  :BootPic/demo.pic -R   -c  7aB
  221.  
  222.   bootpic -E
  223.  
  224.   bootpic -cAE3  -S -l:bootpic/demo.pic -d 7
  225.  
  226.  If -e or -l aren't specified, or if something else was typed wrong, BootPic
  227.  shows the usage.
  228.  If -e AND -l are specified, BootPic acts as if just -e was specified.
  229.  
  230.                                  KOMPATIBILTY
  231.  
  232.  BootPic installs itself in a «kindly» way, that means that any other resident
  233.  programme won't  be removed, e.g. Guardian, CARD:, but also viruses.
  234.  In the same careful way it removes itself.
  235.  It should run on every Amiga with Kick 1.2 or 1.3. It also runs on the A500+
  236.  with OS 2.0, but I'm not sure about the A3000.
  237.  
  238.  Now BootPic also runs on Amigas with 1MB chipram and Kick 1.3. As long as
  239.  BootPic is installed, other resident programms will be executed as well.
  240.  NOTE: It's possible that this patch won't work with 'Setpatch -r'.
  241.        Please avoid using setpach wenn working on an older Kick 1.3/1MB
  242.        chipmem Amiga.
  243.  When BootPic is patching the error, the screen will turn red during reset
  244.  to indicate its presence.
  245.  
  246.                    What happens after RESETTING the machine  ?
  247.  
  248.  When BootPic was successfully installed, the loaded picture will be faded in
  249.  softly whenever there's no bootable disk in df0: [or any other drive] .
  250.  If you additionally loaded a MED-Module, it will be played while the picture
  251.  is shown. Packed modules may need up to 10s to decrunch ! You may abort
  252.  decrunching by pressing the left mousebutton. In this case the picture will
  253.  disappear and the normal Workbenchhand appears.
  254.  If the uncrunched file actually isn't a Module you won't hear anything !
  255.  You may toggle the sound-filter with the right mousebutton ( the filter is
  256.  connected with the PowerLED so you actually toggle both ).
  257.  When inserting a bootable disk the colors will be faded softly to the color
  258.  specified under -c and your system starts as usual .
  259.  [The fading of HAM-pictures looks a little bit curious but that's NO bug.]
  260.  If you press the left mouse button while the picture is shown, the usual
  261.  workbench-hand appears.
  262.  
  263.                          Possbile SOURCES of ERRORS
  264.  
  265.  Normally a picture that was once installed, stays in memory until you remove
  266.  it with -e [Remove Picture] or till you switch off your Amiga.
  267.  But there are some exceptions:
  268.  
  269.   a.)  If you play a game that believes all the memory belongs to itsself, it
  270.        is possible that the memory allocated by BootPic is overwritten.
  271.        Then you won't see the picture any more.
  272.   b.)  Many viruses simply overwrite the reset-vectors. In this case BootPic
  273.        will be gone, too.
  274.   c.)  Some virusdedectors (e.g. ATool) are of the opinion that every resident
  275.        programme is a virus, so BootPic will be removed, too.
  276.  
  277.  If one of these cases should arise, it may be possible, that you get a GURU
  278.  after a reset. If you can't remove it by clicking the left mousebutton,
  279.  switching off the Amiga is the only thing you can do.
  280.  
  281.  
  282.  
  283.                                  HISTORY
  284.  
  285.  V1.0 - first release, only Cli-Support
  286.  V1.1 - intuition-interface
  287.  V1.2 - added 'Color-Cycling' and 'Check all Drives'
  288.       - Resident Code and Data MUST be placed in Chip-Mem [only exception:
  289.         internal expansions of 512k at location $C00000 (e.g. I've this one)].
  290.         Now it uses Chip-Mem. Sorry, I didn't know about this limitation.
  291.       - There was some code that caused BootPic to guru on the A500 Plus with
  292.         OS 2.0 after displaying the picture. Now it works ...
  293.       - Fixed one bug that caused serious errors when loading IFF-files with
  294.         more than 32 colors saved ( like the HAM-Demo-pics of DPaintIV ).
  295.       - Brushes now are handled correctly.
  296.  V2.0 - MED-Module support
  297.  V2.0b- Delay-support
  298.  V2.0c- patch for Kick 1.3
  299.  V2.0d- now should run with MultiKickstartBoards
  300.  V2.1 - included bootselector for Kick1.2/1.3
  301.  
  302.                                PROGRAMMING
  303.  
  304.  BootPic was written with the Devpac 2.14D - Assembler.
  305.  Many thanks go to JM Forgeas for the wonderful editor AZ V1.50.
  306.  Thanks Markus Herpich who provided me his brandnew A500+ for a whole
  307.  afternoon.
  308.  
  309.  The code for playing the sound was written by Teijo Kinnunen.
  310.  I took it from the MEDV3.0 package distributed on Fish 476.
  311.  [Files: loadmod.i and modplayer.i]
  312.  The decrunching code is ©opyrighted by Nico François. I took it from Fish 253.
  313.  
  314.  Also greetings to the 17 ( really seventeen, not more [since june 1991] !)
  315.  kind people who sent me the demanded fee or bug reports. Hope there'll be
  316.  more in future ...
  317.  
  318.  Future Versions:
  319.  Less bugs (I don't know any more, but there surely are ... )
  320.  But remember: future improvements depend on YOUR support !!!
  321.  
  322.  I am very thankful for critics, propositions and BUG-reports.
  323.  [ If you write, please use special stamps if possible, my Grandpa is a
  324.    stamp-collector. Thanks. ]
  325.  
  326.                          ENJOY !
  327.  
  328.   Oberkotzau, july 31st 1992               Andreas Ackermann [*10.07.1974]
  329.   [ excuse my mistakes !!! ]
  330.  
  331.  
  332.